Send an action to the payment provider [adapter]

curl --request POST \
  --url https://payment-provider.example.com/any-prefix/actions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
  "type": "AUTHORIZE",
  "payload": {
    "routeConfiguration": {
      "authentication": {
        "type": "OAuth",
        "endpoint": "https://oauth.customer.com"
      },
      "paymentProviderId": "OGNABTEL",
      "merchantId": "OGNAB_PLUS",
      "routingKey": "12345",
      "countryCode": "MX"
    },
    "paymentAction": {
      "bangoPaymentId": "926f51a4-d992-4bf2-ab57-577007098880",
      "merchantPaymentId": "12343567",
      "merchantRequestId": "asldjfaklsdhfalskjhfd",
      "actionAmount": {
        "amount": 999,
        "currency": "USD"
      },
      "balance": {
        "authorized": {
          "amount": 0,
          "currency": "USD"
        },
        "captured": {
          "amount": 0,
          "currency": "USD"
        },
        "refunded": {
          "amount": 0,
          "currency": "USD"
        },
        "canceled": {
          "amount": 0,
          "currency": "USD"
        }
      },
      "saleItem": {
        "description": "Bango Music - 1 Month Subscription",
        "category": "DIGITAL_GOODS",
        "price": {
          "amount": 999,
          "currency": "USD"
        }
      },
      "shared": {
        "merchantToPaymentProvider": {
          "recombobulationId": "abcd"
        }
      }
    },
    "paymentInstrumentProperties": {
      "account": {
        "phoneNumber": "+447700900123",
        "anyPropertyNeededByThePaymentProvider": "some-string"
      },
      "global": {
        "accountType": "prepaid",
        "countryCode": "US",
        "locale": "en-US",
        "currency": "USD",
        "customerProfile": "saver profile"
      },
      "route": {
        "SOME_MERCHANT_ID": {
          "paymentEligibilityStatus": "barred",
          "userProperties": {
            "token": "myUserToken",
            "accountNickname": 457
          }
        }
      }
    },
    "merchantUserLocale": "en-US"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '2adf1639-bb50-4df7-b8a0-79a0cd4f2277',
    type: 'AUTHORIZE',
    payload: {
      routeConfiguration: {
        authentication: {type: 'OAuth', endpoint: 'https://oauth.customer.com'},
        paymentProviderId: 'OGNABTEL',
        merchantId: 'OGNAB_PLUS',
        routingKey: '12345',
        countryCode: 'MX'
      },
      paymentAction: {
        bangoPaymentId: '926f51a4-d992-4bf2-ab57-577007098880',
        merchantPaymentId: '12343567',
        merchantRequestId: 'asldjfaklsdhfalskjhfd',
        actionAmount: {amount: 999, currency: 'USD'},
        balance: {
          authorized: {amount: 0, currency: 'USD'},
          captured: {amount: 0, currency: 'USD'},
          refunded: {amount: 0, currency: 'USD'},
          canceled: {amount: 0, currency: 'USD'}
        },
        saleItem: {
          description: 'Bango Music - 1 Month Subscription',
          category: 'DIGITAL_GOODS',
          price: {amount: 999, currency: 'USD'}
        },
        shared: {merchantToPaymentProvider: {recombobulationId: 'abcd'}}
      },
      paymentInstrumentProperties: {
        account: {
          phoneNumber: '+447700900123',
          anyPropertyNeededByThePaymentProvider: 'some-string'
        },
        global: {
          accountType: 'prepaid',
          countryCode: 'US',
          locale: 'en-US',
          currency: 'USD',
          customerProfile: 'saver profile'
        },
        route: {
          SOME_MERCHANT_ID: {
            paymentEligibilityStatus: 'barred',
            userProperties: {token: 'myUserToken', accountNickname: 457}
          }
        }
      },
      merchantUserLocale: 'en-US'
    }
  })
};

fetch('https://payment-provider.example.com/any-prefix/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://payment-provider.example.com/any-prefix/actions"

payload = {
    "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
    "type": "AUTHORIZE",
    "payload": {
        "routeConfiguration": {
            "authentication": {
                "type": "OAuth",
                "endpoint": "https://oauth.customer.com"
            },
            "paymentProviderId": "OGNABTEL",
            "merchantId": "OGNAB_PLUS",
            "routingKey": "12345",
            "countryCode": "MX"
        },
        "paymentAction": {
            "bangoPaymentId": "926f51a4-d992-4bf2-ab57-577007098880",
            "merchantPaymentId": "12343567",
            "merchantRequestId": "asldjfaklsdhfalskjhfd",
            "actionAmount": {
                "amount": 999,
                "currency": "USD"
            },
            "balance": {
                "authorized": {
                    "amount": 0,
                    "currency": "USD"
                },
                "captured": {
                    "amount": 0,
                    "currency": "USD"
                },
                "refunded": {
                    "amount": 0,
                    "currency": "USD"
                },
                "canceled": {
                    "amount": 0,
                    "currency": "USD"
                }
            },
            "saleItem": {
                "description": "Bango Music - 1 Month Subscription",
                "category": "DIGITAL_GOODS",
                "price": {
                    "amount": 999,
                    "currency": "USD"
                }
            },
            "shared": { "merchantToPaymentProvider": { "recombobulationId": "abcd" } }
        },
        "paymentInstrumentProperties": {
            "account": {
                "phoneNumber": "+447700900123",
                "anyPropertyNeededByThePaymentProvider": "some-string"
            },
            "global": {
                "accountType": "prepaid",
                "countryCode": "US",
                "locale": "en-US",
                "currency": "USD",
                "customerProfile": "saver profile"
            },
            "route": { "SOME_MERCHANT_ID": {
                    "paymentEligibilityStatus": "barred",
                    "userProperties": {
                        "token": "myUserToken",
                        "accountNickname": 457
                    }
                } }
        },
        "merchantUserLocale": "en-US"
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
  "type": "GET_ELIGIBILITY_RESPONSE",
  "payload": {
    "paymentEligibilityStatus": "enabled",
    "paymentInstrumentProperties": {
      "global": {
        "accountType": "prepaid",
        "locale": "en-US",
        "currency": "USD",
        "customerProfile": "saver"
      },
      "route": {
        "SOME_MERCHANT_ID": {
          "paymentEligibilityStatus": "barred",
          "userProperties": {
            "token": "myUserToken",
            "accountNickname": 457
          }
        }
      }
    }
  }
}

{
  "errors": [
    {
      "code": "invalid-json",
      "meta": {},
      "message": "The request body is not valid JSON",
      "url": "https://developer.bango.com/error-codes/invalid-json"
    }
  ]
}

{
  "errors": [
    {
      "code": "invalid-credentials",
      "meta": {},
      "message": "The supplied credentials are not valid",
      "url": "https://developer.bango.com/error-codes/invalid-credentials"
    }
  ]
}

{
  "errors": [
    {
      "code": "permission-denied",
      "meta": {},
      "message": "The client is not permitted to perform this operation",
      "url": "https://developer.bango.com/error-codes/permission-denied"
    }
  ]
}

{
  "errors": [
    {
      "code": "too-many-requests",
      "meta": {},
      "message": "Request limit reached. Please try again later",
      "url": "https://developer.bango.com/error-codes/too-many-requests"
    }
  ]
}

{
  "errors": [
    {
      "code": "internal-server-error",
      "meta": {
        "canRetry": false
      },
      "message": "The server encountered an unexpected condition which prevented it from fulfilling the request",
      "url": "https://developer.bango.com/error-codes/internal-server-error"
    }
  ],
  "paymentProviderOperationId": "<string>"
}

{
  "errors": [
    {
      "code": "bad-gateway",
      "meta": {
        "canRetry": true
      },
      "message": "The server was unable to complete your request. Please try again later.",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

{
  "errors": [
    {
      "code": "service-unavailable",
      "meta": {
        "canRetry": false
      },
      "message": "The service is undergoing maintenance and is not available. Please try again later",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

{
  "errors": [
    {
      "code": "gateway-timeout",
      "meta": {
        "canRetry": true
      },
      "message": "The server was unable to complete your request. Please try again later.",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

Send an action to the payment provider [adapter]

The Bango Platform uses this endpoint to send an action to a payment provider, or an adapter for a payment provider.

The available actions constitute a small fixed vocabulary for communications initiated by the Bango Platform. An action can:

Ask the payment provider [adapter] to perform an operation
Request data from the payment provider [adapter]
Notify the payment provider [adapter] of an event of interest

Every action sent (a request action) may result in a range of possible responses (response actions) from the payment provider [adapter]. Each request action defines the expected response actions.

Every request action will include a unique id property (UUID v4). This identifies the request action and is not used for any other purpose (it’s not a payment resource ID, for example). The response action corresponding to the request action must include the request action’s id.

HTTP responses

The Bango Platform always sends a request to the payment provider [adapter] over HTTP, and the payment provider [adapter] must return an HTTP response. HTTP requests contain request actions as defined in this specification.

The HTTP response MUST be one of the following:

HTTP 204 NO CONTENT - permitted only if the request needs a simple acknowledgement without specific response data
HTTP 200 OK - containing a response action in the response body. Each request action defines the expected response actions
HTTP 4xx - indicating a problem with the request action
HTTP 5xx - indicating a problem with the payment provider [adapter] system

This specification defines the shape of HTTP 4xx and 5xx responses. These all have a response body containing an errors array, each member of which is an object containing an error code and other data.

If a request to a payment provider [adapter] times out, this is treated the same as an HTTP 503 error from the payment provider [adapter] with canRetry: true.

HTTP 400 BAD REQUEST responses

For HTTP 400 BAD REQUEST responses specifically, the payment provider [adapter] MUST use these values for code for the error conditions listed:

invalid-json
- If the request body isn’t valid JSON format
missing-parameter
- If any required parameter is not present in the request body. For example, id, type, payload, or any required value inside payload.
invalid-parameter
- If any parameter in the request is syntactically invalid. For example, if type is an integer, or if id is not a UUID v4
- If any parameter in the request is semantically invalid. For example, if a payload field specifies a user identifier and that user isn’t recognized by the payment provider [adapter]

The payment provider [adapter] MAY use other values of code for an HTTP 400 BAD REQUEST response with other error conditions. The specification for each request action defines the additional permitted values of code.

HTTP 5xx responses

HTTP 5xx responses indicate a problem with the payment provider [adapter]. This might be a temporary problem caused by a network issue between the Bango Platform and the payment provider [adapter], or it may indicate a more serious, persistent issue.

Any 5xx response from the payment provider [adapter] propagates through the platform as a service error with code payment-provider-failure. The 5xx response from the payment provider [adapter] may specify that the request can be retried, using the meta.canRetry boolean in the 5xx response.

A timeout in the connection from the Bango Platform to the payment provider [adapter] is always reported as a payment-provider-failure that may be retried.

POST

https://payment-provider.example.com/any-prefix

actions

Send an action to the payment provider [adapter]

curl --request POST \
  --url https://payment-provider.example.com/any-prefix/actions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
  "type": "AUTHORIZE",
  "payload": {
    "routeConfiguration": {
      "authentication": {
        "type": "OAuth",
        "endpoint": "https://oauth.customer.com"
      },
      "paymentProviderId": "OGNABTEL",
      "merchantId": "OGNAB_PLUS",
      "routingKey": "12345",
      "countryCode": "MX"
    },
    "paymentAction": {
      "bangoPaymentId": "926f51a4-d992-4bf2-ab57-577007098880",
      "merchantPaymentId": "12343567",
      "merchantRequestId": "asldjfaklsdhfalskjhfd",
      "actionAmount": {
        "amount": 999,
        "currency": "USD"
      },
      "balance": {
        "authorized": {
          "amount": 0,
          "currency": "USD"
        },
        "captured": {
          "amount": 0,
          "currency": "USD"
        },
        "refunded": {
          "amount": 0,
          "currency": "USD"
        },
        "canceled": {
          "amount": 0,
          "currency": "USD"
        }
      },
      "saleItem": {
        "description": "Bango Music - 1 Month Subscription",
        "category": "DIGITAL_GOODS",
        "price": {
          "amount": 999,
          "currency": "USD"
        }
      },
      "shared": {
        "merchantToPaymentProvider": {
          "recombobulationId": "abcd"
        }
      }
    },
    "paymentInstrumentProperties": {
      "account": {
        "phoneNumber": "+447700900123",
        "anyPropertyNeededByThePaymentProvider": "some-string"
      },
      "global": {
        "accountType": "prepaid",
        "countryCode": "US",
        "locale": "en-US",
        "currency": "USD",
        "customerProfile": "saver profile"
      },
      "route": {
        "SOME_MERCHANT_ID": {
          "paymentEligibilityStatus": "barred",
          "userProperties": {
            "token": "myUserToken",
            "accountNickname": 457
          }
        }
      }
    },
    "merchantUserLocale": "en-US"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '2adf1639-bb50-4df7-b8a0-79a0cd4f2277',
    type: 'AUTHORIZE',
    payload: {
      routeConfiguration: {
        authentication: {type: 'OAuth', endpoint: 'https://oauth.customer.com'},
        paymentProviderId: 'OGNABTEL',
        merchantId: 'OGNAB_PLUS',
        routingKey: '12345',
        countryCode: 'MX'
      },
      paymentAction: {
        bangoPaymentId: '926f51a4-d992-4bf2-ab57-577007098880',
        merchantPaymentId: '12343567',
        merchantRequestId: 'asldjfaklsdhfalskjhfd',
        actionAmount: {amount: 999, currency: 'USD'},
        balance: {
          authorized: {amount: 0, currency: 'USD'},
          captured: {amount: 0, currency: 'USD'},
          refunded: {amount: 0, currency: 'USD'},
          canceled: {amount: 0, currency: 'USD'}
        },
        saleItem: {
          description: 'Bango Music - 1 Month Subscription',
          category: 'DIGITAL_GOODS',
          price: {amount: 999, currency: 'USD'}
        },
        shared: {merchantToPaymentProvider: {recombobulationId: 'abcd'}}
      },
      paymentInstrumentProperties: {
        account: {
          phoneNumber: '+447700900123',
          anyPropertyNeededByThePaymentProvider: 'some-string'
        },
        global: {
          accountType: 'prepaid',
          countryCode: 'US',
          locale: 'en-US',
          currency: 'USD',
          customerProfile: 'saver profile'
        },
        route: {
          SOME_MERCHANT_ID: {
            paymentEligibilityStatus: 'barred',
            userProperties: {token: 'myUserToken', accountNickname: 457}
          }
        }
      },
      merchantUserLocale: 'en-US'
    }
  })
};

fetch('https://payment-provider.example.com/any-prefix/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://payment-provider.example.com/any-prefix/actions"

payload = {
    "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
    "type": "AUTHORIZE",
    "payload": {
        "routeConfiguration": {
            "authentication": {
                "type": "OAuth",
                "endpoint": "https://oauth.customer.com"
            },
            "paymentProviderId": "OGNABTEL",
            "merchantId": "OGNAB_PLUS",
            "routingKey": "12345",
            "countryCode": "MX"
        },
        "paymentAction": {
            "bangoPaymentId": "926f51a4-d992-4bf2-ab57-577007098880",
            "merchantPaymentId": "12343567",
            "merchantRequestId": "asldjfaklsdhfalskjhfd",
            "actionAmount": {
                "amount": 999,
                "currency": "USD"
            },
            "balance": {
                "authorized": {
                    "amount": 0,
                    "currency": "USD"
                },
                "captured": {
                    "amount": 0,
                    "currency": "USD"
                },
                "refunded": {
                    "amount": 0,
                    "currency": "USD"
                },
                "canceled": {
                    "amount": 0,
                    "currency": "USD"
                }
            },
            "saleItem": {
                "description": "Bango Music - 1 Month Subscription",
                "category": "DIGITAL_GOODS",
                "price": {
                    "amount": 999,
                    "currency": "USD"
                }
            },
            "shared": { "merchantToPaymentProvider": { "recombobulationId": "abcd" } }
        },
        "paymentInstrumentProperties": {
            "account": {
                "phoneNumber": "+447700900123",
                "anyPropertyNeededByThePaymentProvider": "some-string"
            },
            "global": {
                "accountType": "prepaid",
                "countryCode": "US",
                "locale": "en-US",
                "currency": "USD",
                "customerProfile": "saver profile"
            },
            "route": { "SOME_MERCHANT_ID": {
                    "paymentEligibilityStatus": "barred",
                    "userProperties": {
                        "token": "myUserToken",
                        "accountNickname": 457
                    }
                } }
        },
        "merchantUserLocale": "en-US"
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "2adf1639-bb50-4df7-b8a0-79a0cd4f2277",
  "type": "GET_ELIGIBILITY_RESPONSE",
  "payload": {
    "paymentEligibilityStatus": "enabled",
    "paymentInstrumentProperties": {
      "global": {
        "accountType": "prepaid",
        "locale": "en-US",
        "currency": "USD",
        "customerProfile": "saver"
      },
      "route": {
        "SOME_MERCHANT_ID": {
          "paymentEligibilityStatus": "barred",
          "userProperties": {
            "token": "myUserToken",
            "accountNickname": 457
          }
        }
      }
    }
  }
}

{
  "errors": [
    {
      "code": "invalid-json",
      "meta": {},
      "message": "The request body is not valid JSON",
      "url": "https://developer.bango.com/error-codes/invalid-json"
    }
  ]
}

{
  "errors": [
    {
      "code": "invalid-credentials",
      "meta": {},
      "message": "The supplied credentials are not valid",
      "url": "https://developer.bango.com/error-codes/invalid-credentials"
    }
  ]
}

{
  "errors": [
    {
      "code": "permission-denied",
      "meta": {},
      "message": "The client is not permitted to perform this operation",
      "url": "https://developer.bango.com/error-codes/permission-denied"
    }
  ]
}

{
  "errors": [
    {
      "code": "too-many-requests",
      "meta": {},
      "message": "Request limit reached. Please try again later",
      "url": "https://developer.bango.com/error-codes/too-many-requests"
    }
  ]
}

{
  "errors": [
    {
      "code": "internal-server-error",
      "meta": {
        "canRetry": false
      },
      "message": "The server encountered an unexpected condition which prevented it from fulfilling the request",
      "url": "https://developer.bango.com/error-codes/internal-server-error"
    }
  ],
  "paymentProviderOperationId": "<string>"
}

{
  "errors": [
    {
      "code": "bad-gateway",
      "meta": {
        "canRetry": true
      },
      "message": "The server was unable to complete your request. Please try again later.",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

{
  "errors": [
    {
      "code": "service-unavailable",
      "meta": {
        "canRetry": false
      },
      "message": "The service is undergoing maintenance and is not available. Please try again later",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

{
  "errors": [
    {
      "code": "gateway-timeout",
      "meta": {
        "canRetry": true
      },
      "message": "The server was unable to complete your request. Please try again later.",
      "url": "https://developer.bango.com/error-codes/service-unavailable"
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Bango-Request-Action

enum<string>

The value of type from the request body, indicating the type of request action. Allows payment providers [adapters] to route request actions without inspecting the request body.

Available options:

NOTIFY_SESSION_FLOW,

AUTHORIZE,

CAPTURE,

REFUND,

CANCEL_AUTH,

CHARGE,

GET_ELIGIBILITY,

SEND_MT_MESSAGE,

VALIDATE_PASSPHRASE,

SEND_OTP,

VERIFY_OTP

Body

application/json

An action initiated by the Bango Platform, to be processed by the payment provider [adapter].

The following action types are available. See each action type schema for detailed information on purpose and response action types.

NOTIFY_SESSION_FLOW: Tell the payment provider [adapter] that a merchant partner is starting an identity verification flow
AUTHORIZE: Ask the payment provider [adapter] for payment authorization: the first step in a two-step (Authorize/Capture) payments model.
CAPTURE: Ask the payment provider [adapter] for payment capture: the second step in a two-step (Authorize/Capture) payments model
REFUND: Ask the payment provider [adapter] to charge a payment request: one-step payments model
CANCEL_AUTH: Ask the payment provider [adapter] to cancel an authorization on a payment request.
GET_ELIGIBILITY: Ask the payment provider [adapter] for up-to-date eligibility data for an end user
SEND_MT_MESSAGE: Ask the payment provider [adapter] to send a message to a particular end user device
VALIDATE_PASSPHRASE: Ask the payment provider [adapter] to validate a passphrase to a particular end user device
SEND_OTP: Ask the payment provider [adapter] to send an OTP to a particular end user device
VERIFY_OTP: Ask the payment provider [adapter] to verify an OTP provided by the merchant end user
CHARGE: Ask the payment provider [adapter] to charge a payment request: one-step payments model

AUTHORIZE request action (outbound)
CANCEL_AUTH request action (outbound)
CAPTURE request action (outbound)
CHARGE request action (outbound) [plan-p1]
REFUND request action (outbound)
GET_ELIGIBILITY request action (outbound)
NOTIFY_SESSION_FLOW request action (outbound)
SEND_MT_MESSAGE request action (outbound)
VALIDATE_PASSPHRASE request action (outbound)
SEND_OTP request action (outbound)
VERIFY_OTP request action (outbound)

Ask the payment provider [adapter] for payment authorization: the first step in a two-step (Authorize/Capture) payments model. This step reserves funds against the end user's payment instrument with the payment provider.

How it works: merchant partners send an AUTHORIZE action for a payment resource. Route policy determines whether authorization is permitted. If so, OPPA will send an AUTHORIZE action to the payment provider [adapter].

The payment provider [adapter] responds either to approve or deny authorization (or signal an error in the request).

Supported HTTP responses

HTTP 200 OK:
- AUTHORIZE_APPROVED_RESPONSE response action
- AUTHORIZE_DENIED_RESPONSE response action
HTTP 204 NO CONTENT:
- Simple acknowledgement approving authorization, without additional data
HTTP 400 BAD REQUEST with one or more errors:
- code == invalid-json:
  - the request body is not valid JSON
- code == missing-parameter:
  - a required parameter is omitted from the request action
- code == invalid-parameter:
  - a parameter is not of the expected type, or
  - a parameter violates the documented constraints

string<uuid>

required

A unique identifier for the request action (not used for any other purpose). If the recipient of the request action returns a response action, the response action must specify the same identifier as its own id.

Example:

"2adf1639-bb50-4df7-b8a0-79a0cd4f2277"

type

any

required

payload

object

required

Show child attributes

idempotency

Idempotency properties · object

Properties related to idempotency, to help with reconciliation between the Bango Platform and the payment provider.

Omitted if the merchant partner did not specify an Idempotency-Key with the request.

Show child attributes

Example:

{
  "operationId": "d69113a4-e631-43f5-b054-2567467bbbf7",
  "paymentProviderOperationId": "Jv290FSkm34guhSODUFmvksdfh",
  "isRetry": false
}

Response

The response action, which depends on the request action.

GET_ELIGIBILITY_RESPONSE response action
AUTHORIZE_APPROVED_RESPONSE response action
AUTHORIZE_DENIED_RESPONSE response action
CANCEL_AUTH_APPROVED_RESPONSE response action
CANCEL_AUTH_DENIED_RESPONSE response action
CAPTURE_APPROVED_RESPONSE response action
CAPTURE_DENIED_RESPONSE response action
CHARGE_APPROVED_RESPONSE response action [plan-p1]
CHARGE_DENIED_RESPONSE response action [plan-p1]
REFUND_APPROVED_RESPONSE response action
REFUND_DENIED_RESPONSE response action
NOTIFY_SESSION_FLOW_APPROVED_RESPONSE response action
NOTIFY_SESSION_FLOW_DENIED_RESPONSE response action
SEND_MT_MESSAGE_RESPONSE response action
VALIDATE_PASSPHRASE_RESPONSE response action
SEND_OTP_RESPONSE response action
VERIFY_OTP_RESPONSE response action

Response to a GET_ELIGIBILITY action. Contains information about the current eligibility of an end user.

string<uuid>

required

The unique identifier for the request action to which this is a response.

Example:

"2adf1639-bb50-4df7-b8a0-79a0cd4f2277"

type

any

required

payload

object

required

Show child attributes

Bango Payments

For payment providers

For merchants

Send an action to the payment provider [adapter]

HTTP responses

HTTP 400 BAD REQUEST responses

HTTP 5xx responses

Authorizations

Headers

Body

Supported HTTP responses

Response